home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Toolbox / Visual Basic Toolbox (P.I.E.)(1996).ISO / dde / xraywi12 / install.txt < prev    next >
Text File  |  1994-07-06  |  13KB  |  396 lines
  1.                          X - R a y / W I N S O C K
  2.  
  3.  
  4. Installation
  5. ===============================================================================
  6.  
  7. Create a directory for X-Ray/WINSOCK, i.e. C:\XRAY. Copy all     
  8. the files contained in this ZIP file to that directory. To run the X-Ray     
  9. demonstration, select "Run..." from the "File" menu of the Program    
  10. Manager and type:
  11.  
  12.     C:\XRAY\XRAYWINS
  13.     
  14. Press Ok or <ENTER> to start X-Ray/Winsock.
  15.  
  16.  
  17. Getting Started
  18. ===============================================================================
  19.  
  20. X-Ray/Winsock traces function calls of the Windows Socket (Winsock)
  21. implementation.
  22.  
  23. The first time you run X-Ray/Winsock, follow the procedures below:
  24.  
  25.    1.     In the Help menu, select View README.WRI....
  26.      This command provides information that has become available since the
  27.      manual was printed, and other vital information.
  28.      
  29.    2.     Select Options... (Trace menu) to set your trace preferences..
  30.      Alternatively, press Ctrl + O, or select the Trace icon in the tool
  31.      bar. See "Setting Your Trace Preferences" below for more information.
  32.      
  33.    3.     Select Filters... (Trace menu) to set trace functions and tasks.
  34.      Alternatively, press Ctrl + F, or select the Filters icon in the tool
  35.      bar. See "Selecting Filters" below for more information.
  36.      
  37. Once the menu bar is displayed, you can access help on any menu item by
  38. highlighting it and pressing F1.
  39.  
  40. To access help from the X-Ray/Winsock window, press F1.
  41.  
  42. This program is limited to storing up to 30 most recent trace 
  43. records. The monochrome, file, and printer log options in the Options dialog 
  44. box will also be disabled. The Winsock help facility is disabled. Other-
  45. wise all other features are fully functional.
  46.  
  47. Note: This demonstration does not require WINSOCK.DLL on the     
  48. system in order to execute. However, it won't be much of a demon-     
  49. stration!
  50.  
  51. If you like this product, you may be interested in our other new products:
  52.  
  53.     X-Ray/ODBC tm
  54.     X-Ray/WLIBSOCK tm
  55.  
  56. Call us at (818) 346-2784 for more details!
  57.  
  58.  
  59. Setting Your Trace Preferences
  60. ===============================================================================
  61.  
  62. Select Options... (Trace menu) to access the Trace Options dialog box and
  63. set your trace preferences.
  64.  
  65. Alternatively, press Ctrl + O, or select the Trace icon  in the tool bar.
  66.  
  67.  
  68. Setting Output Options
  69.  
  70. Trace log    Displays trace information to
  71. only         a window.
  72.              
  73. Monochrome   For a monochrome monitor.
  74. Display      This option is grayed if you
  75.              do not have a monochrome video
  76.              card installed in your
  77.              computer.
  78.              
  79. Printer      Outputs trace information to
  80.              your printer.
  81.              
  82. DBWin        Outputs trace information to
  83.              DBWin (a sample debugger
  84.              available with Microsoft
  85.              Windows SDK and Microsoft
  86.              C/C++ (Visual C++TM)).  This
  87.              option also supports output to
  88.              WinScopeTM by Periscope.  X-
  89.              Ray is compatible with any
  90.              program capable of displaying
  91.              messages sent by the function
  92.              OutputDebugString( ).
  93.              
  94.              Be aware that this option can
  95.              slow your system down if many
  96.              trace events are being logged.
  97.              
  98. File         Outputs trace information to a
  99.              log file.  The default log
  100.              file is C:\WINSOCK.LOG.
  101.              However, you can enter another
  102.              file in the Log File text box,
  103.              or choose another log file by
  104.              selecting the Browse button.
  105.              
  106.              The default is Append to
  107.              existing file, which appends
  108.              new trace information to the
  109.              log file you specify.  If you
  110.              deselect the default, the log
  111.              file is deleted and a new file
  112.              is created when you run a
  113.              trace on another function.
  114.              
  115. Log          Select this option if you want
  116. Exception    to log Winsock functions that
  117. s only       return errors only.
  118.              
  119. Level of     Select High to output
  120. detail       information details to
  121.              printer, DBWin, or the file
  122.              you specified in the option
  123.              above.  Select Low to display
  124.              only two lines of information
  125.              to the Event Details dialog
  126.              box.
  127.           
  128.  
  129. Setting Display Options
  130.  
  131. Minimize     Minimizes the X-RAY/Winsock
  132. when trace   application window to an
  133. started      icon.
  134.              
  135. Stop trace   Stops the trace when you
  136. when         activate the X-RAY/Winsock
  137. activated    window.
  138.             
  139.  
  140. Setting the Log File
  141.  
  142. If you selected File in the Output Options field, and if you do not want to
  143. accept the default of C:\WINSOCK.LOG, enter the name of the file to which
  144. you want trace information stored, or choose another log file by selecting
  145. the Browse button.
  146.  
  147.  
  148. Setting Buffer Options
  149.  
  150. The number in parentheses below the Buffer Size option is the amount of
  151. memory in kilobytes.
  152.  
  153. Buffer        Enter the number of records,
  154. Size          between 25 to 2000 inclusive,
  155.               that you want to buffer.
  156.               
  157. Circular      When the number of records is
  158.               one more than the number you
  159.               specified in the Buffer Size
  160.               option, the buffer drops the
  161.               oldest record, giving the
  162.               appearance of an endless
  163.               buffer.  The larger the buffer
  164.               size, the more records it can
  165.               hold before losing the oldest
  166.               record.
  167.               
  168. Stop when     The buffer stops accepting
  169. filled        record when the number of
  170.               records you specified in the
  171.               Buffer Size option is reached.
  172.               The trace is automatically
  173.               stopped.
  174.           
  175.  
  176. Setting Your Preferences and Exiting the Dialog Box
  177.  
  178. Select the Ok button, or press Enter to set your preferences and exit the
  179. dialog box.
  180.  
  181.  
  182.  
  183. Selecting Filters
  184. ===============================================================================
  185.  
  186. Select Filters... (Trace menu) to access the Filters dialog box and set
  187. filters.
  188.  
  189. Alternatively, press Ctrl + F, or select the Filters icon in the tool bar.
  190.  
  191.  
  192. Selecting Trace Functions
  193.  
  194. Select the trace functions you want to run in the API Functions list box.
  195.  
  196. To select all functions in the list box, select the Select All button.  To
  197. cancel the functions you selected, select the Clear button.
  198.  
  199. For more information about these functions, refer to the documentation that
  200. accompanies the Winsock API.
  201.  
  202. X-Ray does not trace the Winsock function WSAGetLastError( ).
  203.  
  204.  
  205. Selecting Tasks
  206.  
  207. Select the applications for which you want trace information in the Active
  208. Application(s) list box.
  209.  
  210. To select all tasks in the list box, select the Select All button.  To
  211. cancel the tasks you selected, select the Clear button.
  212.  
  213. Select Launch specified application if you want to run a trace on an
  214. application that is not displayed in the Active application(s) list box.
  215. To select the application, select the Choose application... button or enter
  216. the command line of the application.
  217.  
  218.  
  219. Skip if WSAWOULDBLOCK
  220.  
  221. WSAWOULDBLOCK is returned if the recv, recvfrom, send, and/or sendto
  222. functions fail because no data could be received or sent.  Select this
  223. option if you do not want WSAWOULDBLOCK logged.
  224.  
  225.  
  226. Exiting the Dialog Box
  227.  
  228. To exit the dialog box without setting any filters, select the Cancel
  229. button.
  230.  
  231. To set your filters and exit the dialog box, select the Ok button or press
  232. Enter.
  233.  
  234.  
  235. Running Traces
  236. ===============================================================================
  237.  
  238.  
  239. Once you have set your trace preferences and filters, you can run traces.
  240. This section discusses the following:
  241.  
  242.      Starting a trace
  243.      
  244.      Stopping a trace
  245.      
  246.      Viewing trace event details
  247.      
  248.      Continuing a trace
  249.      
  250.      Clearing the trace log and buffer
  251.      
  252.  
  253.  
  254. Starting a Trace
  255.  
  256. Select Start (Trace menu), or press Ctrl + S, or select the Start icon  in
  257. the tool bar to start the trace.
  258.  
  259.  
  260.  
  261. Stopping a Trace
  262.  
  263. Select Pause (Trace menu), or press Ctrl + A, or select the Stop icon  to
  264. pause tracing.
  265.  
  266. Alternatively, If you selected the Stop trace when activated option in the
  267. Trace Options dialog box, tracing will stop when you activate X-
  268. Ray/Winsock.
  269.  
  270.  
  271.  
  272. Viewing Trace Event Details
  273. ===============================================================================
  274.  
  275. Select Event Details... (Trace menu) to access the Event Details dialog box
  276. and view details of trace events.
  277.  
  278. Alternatively, double click on a trace record in the X-Ray/Winsock window,
  279. or press Ctrl + E, or select the Details icon in the tool bar.
  280.  
  281. The Event Details dialog box can remain on the screen as long as the trace
  282. buffer is not cleared (by selecting the Clear icon or selecting Reset
  283. Events (Trace menu).
  284.  
  285.  
  286. Using the Event Details Dialog Box
  287.  
  288. Detail       This window displays detail of
  289. List Box     a specified trace.  You can
  290.              specify the trace for which you
  291.              want more detail by double
  292.              clicking on a trace record in
  293.              the X-Ray window, or by
  294.              entering a number in the Record
  295.              text box and pressing the Get
  296.              button.  Alternatively, you can
  297.              scroll through the list box or
  298.              select the Animate button to
  299.              view other records.
  300.              
  301.              The following information is
  302.              displayed for every trace
  303.              detail:
  304.              
  305.              FUNCTION SUMMARY:  A summary of
  306.              the function, including record
  307.              number, function, and the time
  308.              it was called.
  309.              
  310.              PARAMETERS BEFORE CALL:
  311.              Parameters in the code before
  312.              the function is executed.
  313.              
  314.              RETURNS:  Error codes or values
  315.              that are returned by Winsock.
  316.              
  317.              PARAMETERS AFTER CALL:  Values
  318.              that may have been changed by
  319.              Winsock.
  320.              
  321. Close        Select this button to close the
  322. Button       dialog box.
  323.              
  324. Help         Select this button for help on
  325. Button       the dialog box.
  326.              
  327. Start        Select this button if you want
  328. Button       to automate scrolling through
  329.              the detail list box.  To set
  330.              the animation delay, enter the
  331.              number of seconds delay in the
  332.              seconds text box.
  333.              
  334. Speed        Enter the number from 1 to 15.
  335.              The higher the number, the
  336.              slower the animation (that is,
  337.              auto- mated scrolling through
  338.              the detail list box).  The
  339.              range of values equates to .2
  340.              through 3 seconds. You can
  341.              initiate animation by selecting
  342.              the Animate key.
  343.              
  344. Errors       Select this option if you want
  345. Only         to view error messages while
  346.              animation is enabled.
  347.              
  348. Backwards    Select this option if you want
  349.              to animate backwards.
  350.              
  351. Find         Select this button to find a
  352. Button       record.  The Find dialog box is
  353.              displayed.
  354.              
  355.              You can search by any numeric
  356.              or alphabetic characters.  If
  357.              you search alphabetically, you
  358.              can do a case-sensitive search
  359.              (if the word for which you are
  360.              searching contains capital
  361.              letters) by selecting the Match
  362.              Case option.  You can also
  363.              search up or down through
  364.              records.
  365.              
  366. Get          Select this button to retrieve
  367. Button       details for a trace you specify
  368.              in the Record text box.  The
  369.              record is the first field that
  370.              is displayed in the X-
  371.              Ray/Winsock window.  You can
  372.              also use the scroll buttons to
  373.              scroll backward and forward
  374.              through record numbers.
  375.              
  376. Errors       Select these scroll buttons to
  377. Scroll       scroll backward and forward
  378. Buttons      through errors.
  379.          
  380.  
  381.  
  382. Continuing a Trace
  383.  
  384. Select Continue (Trace menu) after you have stopped/paused the trace to
  385. save the current trace and continue tracing events.
  386.  
  387.  
  388. Clearing the Trace Log and Buffer
  389.  
  390. Select Reset Events (Trace menu) or the Clear icon to clear all events from
  391. the trace log and buffer.
  392.  
  393. If you select this command or the Clear icon, and the Event Details dialog
  394. box is displayed, the dialog box will close.
  395.  
  396.